Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Technology Stack docs #551

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

bourque
Copy link
Collaborator

@bourque bourque commented May 8, 2024

Change Summary

Overview

This PR adds a new page to our documentation that describes the "technology stack" we are using to do our work, along with some words on why we chose those tools/libraries, and what other ones we may have considered. I am using the term "technology stack" here but I am definitely open to other suggestions on what to name this page.

This is currently a WIP, and I would like some help filling out some of these sections, as others probably have more insight into some of these than I do. For the sections I have filled out, I made some assumptions in them so it would be good for others to make sure those assumptions are valid!

Also, I changed the name of the parent directory that housed a bunch of docs from development-guide to just development to be consistent with how we were calling it in the docs themselves.

docs/source/development/technology-stack.rst Outdated Show resolved Hide resolved
docs/source/development/technology-stack.rst Outdated Show resolved Hide resolved
everything is written in Python. Python was chosen mostly because at the time of
development, it was the most widely used and supported language for scientific
software development, and the main programming language used within the
Datasystems group at LASP.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: Data Systems

docs/source/development/technology-stack.rst Outdated Show resolved Hide resolved
@greglucas greglucas added the Repo: Documentation Improvements or additions to documentation label May 21, 2024
Copy link
Contributor

@maxinelasp maxinelasp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and a good improvement! Thanks!

<https://smd-cms.nasa.gov/wp-content/uploads/2023/08/smd-information-policy-spd-41a.pdf>`_,
this open-source collaborative GitHub solution made the most sense.

Poetry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe link to the existing poetry docs?

docs/source/development/technology-stack.rst Show resolved Hide resolved
docs/source/development/technology-stack.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@vmartinez-cu vmartinez-cu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition to our documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants